<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>Pod::PlainText - Convert POD data to formatted ASCII text - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Pod-Parser - MetaCPAN" href="https://metacpan.org/dist/Pod-Parser/releases.rss" />
        <link rel="canonical" href="./Pod::PlainText.html" />
        <meta name="description" content="Convert POD data to formatted ASCII text" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/Pod::PlainText" />
<meta name="twitter:title"       content="Pod::PlainText" />
<meta name="twitter:description" content="Convert POD data to formatted ASCII text" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./Pod::PlainText.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Pod-Parser was released.">
      <span class="relatize">03 Jan 2024 21:23:20 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/Pod-Parser">Pod-Parser</a>
  </li>
  <li>
    Module version: 2.07
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/Pod-Parser/source/lib/Pod/PlainText.pm">Source</a>
    (<a href="https://metacpan.org/dist/Pod-Parser/source/lib/Pod/PlainText.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/Pod-Parser/source/lib/Pod">Browse</a>
    (<a href="https://metacpan.org/dist/Pod-Parser/source/lib/Pod?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/Pod-Parser/changes">Changes</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/Pod-Parser/contribute">How to Contribute</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Parser">Issues</a>
      (0)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Pod-Parser+1.67" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Parser.html?oncpan=1&amp;distmat=1&amp;version=1.67&amp;grade=2" style="color: #090">334</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Parser.html?oncpan=1&amp;distmat=1&amp;version=1.67&amp;grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Parser.html?oncpan=1&amp;distmat=1&amp;version=1.67&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/MAREKR/Pod-Parser-1.67">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Pod-Parser who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 5
      </div>
    </li>
    <li>
      License: unknown
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/Pod-Parser/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/M/MA/MAREKR/Pod-Parser-1.67.tar.gz">
      Download (<span itemprop="fileSize">79.06KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FMAREKR%2FPod-Parser-1.67%2Flib%2FPod%2FPlainText.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Pod-Parser/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Pod-Parser/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:Pod-Parser">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="Pod-Parser">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Pod/PlainText.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="MAREKR/Pod-Parser-1.67"
>1.67
  (MAREKR on 2024-01-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.66"
>1.66
  (MAREKR on 2023-04-22)</option>
<option
  
  value="MAREKR/Pod-Parser-1.65"
>1.65
  (MAREKR on 2022-05-21)</option>
<option
  
  value="MAREKR/Pod-Parser-1.64"
>1.64
  (MAREKR on 2022-05-21)</option>
<option
  
  value="MAREKR/Pod-Parser-1.63"
>1.63
  (MAREKR on 2015-02-10)</option>
<option
  
  value="MAREKR/Pod-Parser-1.62"
>1.62
  (MAREKR on 2014-02-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.51"
>1.51
  (MAREKR on 2012-01-25)</option>
<option
  
  value="MAREKR/Pod-Parser-1.38"
>1.38
  (MAREKR on 2009-02-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="MAREKR/Pod-Parser-1.61"
>1.61
  (MAREKR on 2013-06-01)</option>
<option
  
  value="MAREKR/Pod-Parser-1.60"
>1.60
  (MAREKR on 2013-02-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.50"
>1.50
  (MAREKR on 2012-01-22)</option>
<option
  
  value="MAREKR/Pod-Parser-1.37"
>1.37
  (MAREKR on 2009-02-04)</option>
<option
  
  value="MAREKR/Pod-Parser-1.36"
>1.36
  (MAREKR on 2009-01-20)</option>
<option
  
  value="MAREKR/Pod-Parser-1.35"
>1.35
  (MAREKR on 2006-10-26)</option>
<option
  
  value="MAREKR/Pod-Parser-1.34"
>1.34
  (MAREKR on 2005-10-06)</option>
<option
  
  value="MAREKR/Pod-Parser-1.33"
>1.33
  (MAREKR on 2005-09-05)</option>
<option
  
  value="MAREKR/Pod-Parser-1.32"
>1.32
  (MAREKR on 2005-06-15)</option>
<option
  
  value="MAREKR/Pod-Parser-1.31"
>1.31
  (MAREKR on 2005-06-01)</option>
<option
  
  value="MAREKR/Pod-Parser-1.30"
>1.30
  (MAREKR on 2005-03-13)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/MAREKR/Pod-Parser-1.67/diff/' + encodeURIComponent(this.value) + '/lib/Pod/PlainText.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="MAREKR/Pod-Parser-1.67"
>1.67
  (MAREKR on 2024-01-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.66"
>1.66
  (MAREKR on 2023-04-22)</option>
<option
  
  value="MAREKR/Pod-Parser-1.65"
>1.65
  (MAREKR on 2022-05-21)</option>
<option
  
  value="MAREKR/Pod-Parser-1.64"
>1.64
  (MAREKR on 2022-05-21)</option>
<option
  
  value="MAREKR/Pod-Parser-1.63"
>1.63
  (MAREKR on 2015-02-10)</option>
<option
  
  value="MAREKR/Pod-Parser-1.62"
>1.62
  (MAREKR on 2014-02-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.51"
>1.51
  (MAREKR on 2012-01-25)</option>
<option
  
  value="MAREKR/Pod-Parser-1.38"
>1.38
  (MAREKR on 2009-02-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="MAREKR/Pod-Parser-1.61"
>1.61
  (MAREKR on 2013-06-01)</option>
<option
  
  value="MAREKR/Pod-Parser-1.60"
>1.60
  (MAREKR on 2013-02-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.50"
>1.50
  (MAREKR on 2012-01-22)</option>
<option
  
  value="MAREKR/Pod-Parser-1.37"
>1.37
  (MAREKR on 2009-02-04)</option>
<option
  
  value="MAREKR/Pod-Parser-1.36"
>1.36
  (MAREKR on 2009-01-20)</option>
<option
  
  value="MAREKR/Pod-Parser-1.35"
>1.35
  (MAREKR on 2006-10-26)</option>
<option
  
  value="MAREKR/Pod-Parser-1.34"
>1.34
  (MAREKR on 2005-10-06)</option>
<option
  
  value="MAREKR/Pod-Parser-1.33"
>1.33
  (MAREKR on 2005-09-05)</option>
<option
  
  value="MAREKR/Pod-Parser-1.32"
>1.32
  (MAREKR on 2005-06-15)</option>
<option
  
  value="MAREKR/Pod-Parser-1.31"
>1.31
  (MAREKR on 2005-06-01)</option>
<option
  
  value="MAREKR/Pod-Parser-1.30"
>1.30
  (MAREKR on 2005-03-13)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="https://metacpan.org/pod/Cwd" title="Cwd" class="ellipsis">Cwd</a></li>
  <li><a href="https://metacpan.org/pod/File::Basename" title="File::Basename" class="ellipsis">File::Basename</a></li>
  <li><a href="https://metacpan.org/pod/Test::More" title="Test::More" class="ellipsis">Test::More</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/Pod::PlainText/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=Pod%3A%3APlainText">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=Pod-Parser">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/MAREKR/Pod-Parser-1.67/view/lib/Pod/PlainText.pm">This version</a>
    </li>
    <li>
      <a href="./Pod::PlainText.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
<a class="display-all" href="https://metacpan.org/author/YOUPONG"><img src="https://www.gravatar.com/avatar/45be30d66c5f5cb4d9ba25f35af52596?d=identicon&amp;s=20" title="YOUPONG" alt="YOUPONG"></a>
<a class="display-all" href="https://metacpan.org/author/XAV"><img src="https://www.gravatar.com/avatar/37f9cbd6749507cadc1df1efeec95771?d=identicon&amp;s=20" title="XAV" alt="XAV"></a>
<a class="display-all" href="https://metacpan.org/author/JMATES"><img src="https://www.gravatar.com/avatar/06accb84e6519284be3941ff72e429cb?d=identicon&amp;s=20" title="JMATES" alt="JMATES"></a>
<a class="display-all" href="https://metacpan.org/author/DOHERTY"><img src="https://www.gravatar.com/avatar/9533c36b6385c8321bad636c98e9c0a8?d=identicon&amp;s=20" title="DOHERTY" alt="DOHERTY"></a>
<a class="display-all" href="https://metacpan.org/author/KEEDI"><img src="https://www.gravatar.com/avatar/95f905a7a4ccc573c711e9d264c0fde8?d=identicon&amp;s=20" title="KEEDI" alt="KEEDI"></a>
</div>
<!-- Display counts of plussers-->
<div>
    <a href="https://metacpan.org/dist/Pod-Parser/plussers">7 PAUSE users</a>
</div>
<div>
    6 non-PAUSE users
</div>
</div>
    </li>
    <li>
<div id="metacpan_contributors">
  <div>
    <button class="btn-link"
      onclick="$(this).hide(); $('#metacpan_contributors ul').slideDown(); return false;"
    >and 1 contributors</button>
  </div>
  <ul style="display: none">
    <li class="contributor"
      data-contrib-email="bradapp@enteract.com"
    >
      <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&amp;s=20" />
      Brad Appleton, Marek Rouchal &lt;marekr@cpan.org&gt;
    </li>
  </ul>
</div>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/MAREKR" class="author-name">Marek Rouchal</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Pod/PlainText.pm&#39;" class="">
<option
  selected
  value="MAREKR/Pod-Parser-1.67"
>1.67
  (MAREKR on 2024-01-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.66"
>1.66
  (MAREKR on 2023-04-22)</option>
<option
  
  value="MAREKR/Pod-Parser-1.65"
>1.65
  (MAREKR on 2022-05-21)</option>
<option
  
  value="MAREKR/Pod-Parser-1.64"
>1.64
  (MAREKR on 2022-05-21)</option>
<option
  
  value="MAREKR/Pod-Parser-1.63"
>1.63
  (MAREKR on 2015-02-10)</option>
<option
  
  value="MAREKR/Pod-Parser-1.62"
>1.62
  (MAREKR on 2014-02-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.51"
>1.51
  (MAREKR on 2012-01-25)</option>
<option
  
  value="MAREKR/Pod-Parser-1.38"
>1.38
  (MAREKR on 2009-02-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="MAREKR/Pod-Parser-1.61"
>1.61
  (MAREKR on 2013-06-01)</option>
<option
  
  value="MAREKR/Pod-Parser-1.60"
>1.60
  (MAREKR on 2013-02-03)</option>
<option
  
  value="MAREKR/Pod-Parser-1.50"
>1.50
  (MAREKR on 2012-01-22)</option>
<option
  
  value="MAREKR/Pod-Parser-1.37"
>1.37
  (MAREKR on 2009-02-04)</option>
<option
  
  value="MAREKR/Pod-Parser-1.36"
>1.36
  (MAREKR on 2009-01-20)</option>
<option
  
  value="MAREKR/Pod-Parser-1.35"
>1.35
  (MAREKR on 2006-10-26)</option>
<option
  
  value="MAREKR/Pod-Parser-1.34"
>1.34
  (MAREKR on 2005-10-06)</option>
<option
  
  value="MAREKR/Pod-Parser-1.33"
>1.33
  (MAREKR on 2005-09-05)</option>
<option
  
  value="MAREKR/Pod-Parser-1.32"
>1.32
  (MAREKR on 2005-06-15)</option>
<option
  
  value="MAREKR/Pod-Parser-1.31"
>1.31
  (MAREKR on 2005-06-01)</option>
<option
  
  value="MAREKR/Pod-Parser-1.30"
>1.30
  (MAREKR on 2005-03-13)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/Pod-Parser">Pod-Parser-1.67</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage four &#10;
          • 98 direct dependents &#10;          • 1275 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="10"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="15"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="Pod-Parser-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="Pod-Parser-1.67">
    <input type="hidden" name="author" value="MAREKR">
    <input type="hidden" name="distribution" value="Pod-Parser">
    <button type="submit" class="favorite highlight"><span>13</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./Pod::PlainText.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>13</span> ++</a>
</div>
   / <span>Pod::PlainText</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./Pod::PlainText.html#NAME">NAME</a></li>
  <li><a href="./Pod::PlainText.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./Pod::PlainText.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./Pod::PlainText.html#DIAGNOSTICS">DIAGNOSTICS</a></li>
  <li><a href="./Pod::PlainText.html#RESTRICTIONS">RESTRICTIONS</a></li>
  <li><a href="./Pod::PlainText.html#NOTES">NOTES</a></li>
  <li><a href="./Pod::PlainText.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./Pod::PlainText.html#AUTHOR">AUTHOR</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>Pod::PlainText - Convert POD data to formatted ASCII text</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>    use Pod::PlainText;
    my $parser = Pod::PlainText-&gt;new (sentence =&gt; 0, width =&gt; 78);

    # Read POD from STDIN and write to STDOUT.
    $parser-&gt;parse_from_filehandle;

    # Read POD from file.pod and write to file.txt.
    $parser-&gt;parse_from_file (&#39;file.pod&#39;, &#39;file.txt&#39;);</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p><b>NOTE: This module is considered legacy; modern Perl releases (5.31.1 and higher) are going to remove Pod-Parser from core and use <a href="https://metacpan.org/pod/Pod::Simple">Pod::Simple</a> for all things POD.</b></p>

<p>Pod::PlainText is a module that can convert documentation in the POD format (the preferred language for documenting Perl) into formatted ASCII. It uses no special formatting controls or codes whatsoever, and its output is therefore suitable for nearly any device.</p>

<p>As a derived class from Pod::Parser, Pod::PlainText supports the same methods and interfaces. See <a href="./Pod::Parser.html">Pod::Parser</a> for all the details; briefly, one creates a new parser with <code>Pod::PlainText-&gt;new()</code> and then calls either parse_from_filehandle() or parse_from_file().</p>

<p>new() can take options, in the form of key/value pairs, that control the behavior of the parser. The currently recognized options are:</p>

<dl>

<dt id="alt">alt</dt>
<dd>

<p>If set to a true value, selects an alternate output format that, among other things, uses a different heading style and marks <code>=item</code> entries with a colon in the left margin. Defaults to false.</p>

</dd>
<dt id="indent">indent</dt>
<dd>

<p>The number of spaces to indent regular text, and the default indentation for <code>=over</code> blocks. Defaults to 4.</p>

</dd>
<dt id="loose">loose</dt>
<dd>

<p>If set to a true value, a blank line is printed after a <code>=headN</code> headings. If set to false (the default), no blank line is printed after <code>=headN</code>. This is the default because it&#39;s the expected formatting for manual pages; if you&#39;re formatting arbitrary text documents, setting this to true may result in more pleasing output.</p>

</dd>
<dt id="sentence">sentence</dt>
<dd>

<p>If set to a true value, Pod::PlainText will assume that each sentence ends in two spaces, and will try to preserve that spacing. If set to false, all consecutive whitespace in non-verbatim paragraphs is compressed into a single space. Defaults to true.</p>

</dd>
<dt id="width">width</dt>
<dd>

<p>The column at which to wrap text on the right-hand side. Defaults to 76.</p>

</dd>
</dl>

<p>The standard Pod::Parser method parse_from_filehandle() takes up to two arguments, the first being the file handle to read POD from and the second being the file handle to write the formatted output to. The first defaults to STDIN if not given, and the second defaults to STDOUT. The method parse_from_file() is almost identical, except that its two arguments are the input and output disk files instead. See <a href="./Pod::Parser.html">Pod::Parser</a> for the specific details.</p>

<h1 id="DIAGNOSTICS">DIAGNOSTICS</h1>

<dl>

<dt id="Bizarre-space-in-item"><a id="Bizarre"></a>Bizarre space in item</dt>
<dd>

<p>(W) Something has gone wrong in internal <code>=item</code> processing. This message indicates a bug in Pod::PlainText; you should never see it.</p>

</dd>
<dt id="Can&#39;t-open-%s-for-reading:-%s"><a id="Can"></a><a id="Can-t-open--s-for-reading:--s"></a>Can&#39;t open %s for reading: %s</dt>
<dd>

<p>(F) Pod::PlainText was invoked via the compatibility mode pod2text() interface and the input file it was given could not be opened.</p>

</dd>
<dt id="Unknown-escape:-%s"><a id="Unknown"></a><a id="Unknown-escape:--s"></a>Unknown escape: %s</dt>
<dd>

<p>(W) The POD source contained an <code>E&lt;&gt;</code> escape that Pod::PlainText didn&#39;t know about.</p>

</dd>
<dt id="Unknown-sequence:-%s"><a id="Unknown1"></a><a id="Unknown-sequence:--s"></a>Unknown sequence: %s</dt>
<dd>

<p>(W) The POD source contained a non-standard internal sequence (something of the form <code>X&lt;&gt;</code>) that Pod::PlainText didn&#39;t know about.</p>

</dd>
<dt id="Unmatched-=back"><a id="Unmatched"></a><a id="Unmatched--back"></a>Unmatched =back</dt>
<dd>

<p>(W) Pod::PlainText encountered a <code>=back</code> command that didn&#39;t correspond to an <code>=over</code> command.</p>

</dd>
</dl>

<h1 id="RESTRICTIONS">RESTRICTIONS</h1>

<p>Embedded Ctrl-As (octal 001) in the input will be mapped to spaces on output, due to an internal implementation detail.</p>

<h1 id="NOTES">NOTES</h1>

<p>This is a replacement for an earlier Pod::Text module written by Tom Christiansen. It has a revamped interface, since it now uses Pod::Parser, but an interface roughly compatible with the old Pod::Text::pod2text() function is still available. Please change to the new calling convention, though.</p>

<p>The original Pod::Text contained code to do formatting via termcap sequences, although it wasn&#39;t turned on by default and it was problematic to get it to work at all. This rewrite doesn&#39;t even try to do that, but a subclass of it does. Look for <a href="https://metacpan.org/pod/Pod::Text::Termcap">Pod::Text::Termcap</a>.</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<p><b>Pod::PlainText</b> is part of the <a href="./Pod::Parser.html">Pod::Parser</a> distribution.</p>

<p><a href="./Pod::Parser.html">Pod::Parser</a>, <a href="https://metacpan.org/pod/Pod::Text::Termcap">Pod::Text::Termcap</a>, pod2text(1)</p>

<h1 id="AUTHOR">AUTHOR</h1>

<p>Please report bugs using <a href="http://rt.cpan.org">http://rt.cpan.org</a>.</p>

<p>Russ Allbery &lt;rra@stanford.edu&gt;, based <i>very</i> heavily on the original Pod::Text by Tom Christiansen &lt;tchrist@mox.perl.com&gt; and its conversion to Pod::Parser by Brad Appleton &lt;bradapp@enteract.com&gt;.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install Pod::Parser, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm Pod::Parser</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install Pod::Parser</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./Pod::PlainText.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
